Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] feat: add ORA filter for student_view rendering intervention #2000

Closed

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Jul 27, 2023

TL;DR - Add an Open edX Filter for student_view

This PR adds a new extension point for the student_view handler. By triggering an Open edX Filter before rendering the block's student_view we could:

  • Modify the template/context being rendered by the student view during runtime -- eg. by using a plugin that extends ORA
  • Access the block status for the student

What motivates us to add this filter is this case specifically:
As a professor or student, I want to check my essay with an external service like Turnitin for plagiarism.

More on the filter's definition in this PR: openedx/openedx-filters#107

What changed?

  • A new Open edX Filter is triggered before returning the student fragment. When there is no filter configured, this change acts as a noop.
  • We added the block object to the context so the filter can access the needed data, which can be a lot when rendering a template. We're open to suggestions on how we can improve it!
  • Added openedx-filters to the requirements list

Developer Checklist

Testing Instructions

This is a proof of concept, so testing it can be wacky. Here's a list of steps you can follow so you can test the ongoing implementation:

  1. Install the needed libraries:
pip install git+https://github.com/openedx/openedx-filters.git@MJG/ora-student-view-filter
pip install git+https://github.com/eduNEXT/edx-ora2.git@MJG/ora-student-view-filter
pip install git+https://github.com/eduNEXT/platform-plugin-turnitin.git@MJG/turnitin-pipeline-step
  1. Add the following configuration:
    OPEN_EDX_FILTERS_CONFIG = {
      "org.openedx.learning.ora.student_view.render.started.v1": {
          "fail_silently": False,
          "pipeline": [
              "platform_plugin_turnitin.extensions.filters.CheckTurnitinForPlagiarism",
          ]
      },
    }
  1. Restart services
  2. Configure an ORA block for text submissions
  3. Submit your assessment

Reviewer Checklist

Collectively, these should be completed by reviewers of this PR:

  • I've done a visual code review
  • I've tested the new functionality

@mariajgrimaldi mariajgrimaldi changed the title feat: add ORA filter for student_view rendering intervention [WIP] feat: add ORA filter for student_view rendering intervention Jul 27, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 3, 2023

Thanks for the pull request, @mariajgrimaldi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

This is currently a draft pull request. When it is ready for our review and all tests are green, click "Ready for Review", or remove "WIP" from the title, as appropriate.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 3, 2023
@itsjeyd itsjeyd added core contributor PR author is a Core Contributor (who may or may not have write access to this repo). waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Aug 8, 2023
@itsjeyd
Copy link

itsjeyd commented Aug 8, 2023

Thanks for the contribution @mariajgrimaldi! :)

@itsjeyd
Copy link

itsjeyd commented Sep 13, 2023

Hey @mariajgrimaldi, just checking in to see if you're still planning to continue working on this PR?

@mariajgrimaldi
Copy link
Member Author

@itsjeyd: thanks for reaching out! I'll close this for the time being and re-open it when needed.

@openedx-webhooks
Copy link

@mariajgrimaldi Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

1 similar comment
@openedx-webhooks
Copy link

@mariajgrimaldi Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

@itsjeyd
Copy link

itsjeyd commented Sep 13, 2023

@mariajgrimaldi Sounds good, thanks 🙂

@itsjeyd itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants